10. Internet Service Commands > 10.3 AT^SISS   Internet Service Setup Profile

10.3
AT^SISS   Internet Service Setup Profile
AT^SISS serves to set up the necessary parameters in the Internet service profiles. Any service profile can then be used to control a data link in conjunction with AT^SISI, AT^SISO, AT^SISC, AT^SISR, AT^SISW and AT^SISE.

The AT^SISS read command requests the current settings of all Internet service profiles. One line is issued for every possible parameter of a given <srvParmTag> "srvType" value.

The AT^SISS write command specifies the parameters for a service profile identified by <srvProfileId>. At first the type of Internet service needs to be selected via <srvParmTag> value "srvType". This determines the applicability of all other <srvParmTag> values related to this "srvType" and sets their defaults. Changing the <srvParmTag> "srvType" of an existing service profile will reset all <srvParmTag> default values to suit the new "srvType". An exception is the <srvParmValue-alphabet> which can be set before or after selecting "srvType" and is not reset when "srvType" changes.

To change the settings the write command needs to be executed for each single <srvParmTag>. All profile parameters set with AT^SISS are volatile.

The list below shows which <srvParmTag> parameters apply to each Internet service and which of them are mandatory or optional.
Table 10.2:

Socket service

FTP service

HTTP service

SMTP service

POP3 service

Syntax
Test Command  
Response(s)
Read Command  
Response(s)
Write Command  
Response(s)
PIN 
ASC0 
ASC1 
USB 
MUX1 
MUX2 
MUX3 
Charge 
Last 

Parameter Description
 
Internet service profile identifier.
The <srvProfileId> is used to reference all parameters related to the same service profile. Furthermore, when using the AT commands AT^SISO, AT^SISR, AT^SISW and AT^SISC the <srvProfileId> is needed to select a specific service profile.
0...9
 
 
Internet service profile parameter.
srvType
Type of Internet service to be configured with consecutive usage of AT^SISS.
For supported values of <srvParmValue> refer to <srvParmValue-srv­Type>.
alphabet
Selects the character set for input and output of string parameters within a pro­file.
The selected value is bound to the specific profile. This means that different profiles may use different alphabets. Unlike other parameters the alphabet can be changed no matter whether the <srvParmTag> value "srvType" has been set.
For supported values of <srvParmValue> refer to <srvParmValue-alphabet>.
user
User name string
1.
Socket
Not applicable.
2.
FTP
Not applicable; set within "address" parameter.
3.
HTTP
Length: 2 ... 31
User name for the HTTP authentication mechanism. Currently only HTTP simple authentication is supported.
4.
SMTP
User name to be used for SMTP authentication (string).
Length: 4 ... 64.
If SMTP authentication is disabled, i.e. "smAuth" flag not set, user name parameter will be ignored.
5.
POP3
User name identifying a mailbox, i.e. mailbox name (string).
Length: 1 ... 64.
passwd
Password string
1.
Socket
Not applicable.
2.
FTP
Not applicable; set within "address" parameter.
3.
HTTP
Length: 2 ... 31
Password for the HTTP authentication mechanism. Currently HTTP simple authentication is supported only.
4.
SMTP
Password to be used for SMTP authentication (string).
Length: 4 ... 64.
If SMTP authentication is disabled, i.e. "smAuth" flag not set, password parameter will be ignored.
5.
POP3
Server/mailbox-specific password (string).
Length: 1 ... 64.
Used to perform authentication with a POP3 server.
conId
Internet connection profile to be used, for details refer AT^SICS.
tcpPort
TCP Port Number
1.
Socket
Not applicable; set within "address" parameter.
2.
FTP
Not applicable; set within "address" parameter.
3.
HTTP
Not applicable; set within "address" parameter.
If parameter is omitted the service connects to HTTP default port 80.
4.
SMTP
SMTP server TCP port number (numeric)
Length: 0 ... 216-1
If this parameter is not set, SMTP default port number 25 is used.
5.
POP3
POP3 server TCP port number (numeric)
Length: 0 ... 216-1
If this parameter is not set, POP3 default port number 110 is used.
address
String value, depending on the service type either a URL in the case of Socket, FTP and HTTP or an address in the case of SMTP and POP3:
1.
-
Socket type TCP client URL
"socktcp://'host':'remote tcpPort'[;disnagle='0|1'] "
"disnagle" is optional for disabling the TCP Nagle algorithm.
0: Nagle algorithm is enabled (default).
1: Nagle algorithm is disabled.
-
Socket type TCP server URL
"socktcp://listener:'local tcpPort' "
-
Socket type UDP endpoint URL
"sockudp://:'local udpPort' "
-
Socket type UDP client URL
"sockudp://'host':'remote udpPort'[;size='byte'][;port='word']"
Parameter "size" (optional):
0: PDU size is variable (default).
1 ... 1500: Fixed PDU size in bytes.
Parameter "port" (optional):
0: Port number will be assigned from service (default).
1 ... 216-1: defines the local port number for the UDP client.
2.
-
FTP client URL (get)
"ftp://'user':'password'@'host':'tcpPort'/'url-path' [;type='a|i|d'] "
Refer to "IETF-RFC 1738".
-
FTP client URL (put)
"ftpput://'user':'password'@'host':'tcpPort'/'url-path'/'element name' [;type='a|i'][;mode='u|a|d'] "
Used parameters:
"host" is mandatory, all other parameters are optional.
If "password" is set then "user" must be set as well.
If "user" is omitted the string "anonymous" is selected for "user" and "pass­word".
If "password" is omitted the password request is served by an empty string.
If "tcpPort" is omitted the service connects to the FTP default port 21.
If "url-path" contains only the IP address a directory listing is requested.
If "url-path" contains the IP address and has a slash '/' appended a detailed directory listing is requested.
"type": [a)scii | i)mage | d)irectory]
"mode": [u)nique | a)ppend | d)elete]
"u)nique" selects the FTP Store Unique command to create a file name unique to the current directory. If the file name is assigned by the server then the "^SIS" URC will appear, indicating <urcInfoId> 2100 and the file name.
"d)elete" clears given 'element name'.
If "mode" is omitted "replace mode" is default setting.
3.
HTTP
HTTP client URL
Length: 6 ... 255
"http://'server'/'path':'tcpPort' "
"server": FQDN or IP-address
"path": path of file or directory
"tcpPort": If parameter is omitted the service connects to HTTP default port 80.
Refer to "IETF-RFC 2616".
4.
5.
hcContent
Optional parameter for HTTP method "Post".
Length: 0 ... 127
Can be used to transfer a small amount of data. The content of this string will only be sent if "hcContLen" = 0. The maximum length of "hcContent" is 127 bytes.
To transmit a larger amount of data "hcContLen" must be set to a non-zero value. In this case the "hcContent" string will be ignored, and data transmission from the client to the server is done with AT^SISW.
hcContLen
Mandatory parameter for HTTP method "Post".
Length: 0 ... 231-1
The content length shall be set in the header of the HTTP "Post" request before the data part is transferred.
If "hcContLen" = 0 then the data given in the "hcContent" string will be posted.
If "hcContLen" > 0 then the AT^SISW command will be used to send data from the client to the server. In this case, "hcContLen" specifies the total amount of data to be sent. The data can be sent in one or several parts. For each part, the transmission is triggered by the URC "^SISW: x, 1", then the AT^SISW write command can be executed. After the exact number of bytes are transferred via the serial interface, the HTTP client will go from service state "Up" to service state "Closing" (see parameters <srvState> and <srvState> for detail). Finally, the URC "^SISW: x, 2" indicates that all data have been transferred and the service can be closed with AT^SISC.
hcUsrAgent
The user agent string must be set by the application to identify the mobile. Usu­ally operation system and software version info is set with this browser identi­fier.
Length: 0 ... 63
hcMethod
HTTP method specification: 0=GET, 1=POST, 2=HEAD.
hcProp
Parameter for several HTTP settings.
Length: 0 ... 127
The general format is 'key': <space> 'value' "\0d\0a".
Multiple settings can be given separated by "\0d\0a" sequences within the string.
Possible 'key' values are defined at HTTP/1.1 Standard RFC 2616.
hcRedir
This flag controls the redirection mechanism of the TC65 acting as HTTP client (numeric).
If "hcRedir" = 0: No redirection.
If "hcRedir" = 1: The client automatically sends a new HTTP request if the server answers with a redirect code (range 30x).
Default is 1.
hcAuth
If set ("hcAuth" = 1) this flag determines that the HTTP client will automatically answer on authentication requests from the server with the current "passwd" and "user" parameter settings. If these parameters are not specified the TC65 will terminate the HTTP connection and send an indication to the TA.
Default is 1.
smFrom
Email sender address, i.e. "MAIL FROM" address (string).
Length: 6 ... 256
A valid address parameter consists of local part and domain name delimited by a '@' character, e.g. "john.smith@somedomain.de".
smRcpt
Recipient address of the email, i.e. "RCPT TO" address (string).
Length: 6 ... 256
If multiple recipient addresses are to be supplied the comma character is used as delimiter to separate individual address values, e.g. "john.smith@somedo­main.de,tom.meier@somedomain.de". Some mail servers do not accept recip­ient addresses without brackets <>. It is recommended to use the "RCPT TO" variable with brackets.
smCC
CC recipient address of the email (string).
Length: 6 ... 256
If multiple CC recipient addresses are to be supplied the comma character is used as delimiter to separate individual address values, e.g. "john.smith@somedomain.de,tom.meier@somedomain.de".
smSubj
Subject content of the email (string).
Length: 0 ... 256
If no subject is supplied the email will be sent with an empty subject.
smHdr
This parameter, if set, will be appended at the end of the email header section (string).
Length: 0... 256
Hence, it serves as a generic header field parameter which allows the user to provide any email header field. It is the user's responsibility to provide correct header fields!
String of max. 256 characters.
Example for multipart MIME messages:
"Content-Type: multipart/mixed".
smAuth
SMTP authentication control flag (numeric).
If disabled (<srvParmValue> "0" by default), TC65 performs action without SMTP authentication.
If enabled (<srvParmValue> "1") authentication procedure with the SMTP server will be performed by means of supported authentication methods, using values of "user" and "passwd" parameters. If TC65 and SMTP server are not able to negotiate an authentication mechanism supported by both parties, the TC65 continues action without authentication.
TC65 supports SMTP authentication.
pCmd
POP3 user command to be executed by the POP3 service (numeric).
For supported values of <srvParmValue> refer to <srvParmValue-pCmd>.
pNumber
Optional message number argument used by the POP3 commands List ("2"), Retrieve ("3") and Delete ("4"). For POP3 commands see <srvParmTag> value "pCmd".
Length: 0 ... 231-1
If no specific value is set in the service profile, the value "0" is assumed by default, i.e. "pNumber" is disabled.
pLength
Maximum message length (string, optional)
Length: 0 ... 231-1
"pLength" can be used to specify the length of the message(s) to be retrieved from or deleted on the POP3 server. If no specific value is set in the service profile, the default value "0" is assumed, which means that there is no limit on the message size.
A warning will be issued inthe following cases:
•
•
No warning will be issued in the following cases:
•
•
If the server has message(s) below and above the "pLength" specified. In this case, the message(s) within the range of "pLength" can be successfully retrieved or deleted, but the message(s) above "pLength" remain on the server without any further notification given to the user.
•
Therefore, after retrieving / deleting messages, it is recommended to check the message status on the server. This can be done by adding a further POP3 service profile using the POP3 user command List ("2").
pDelFlag
Flag to be used with the POP3 user command Retrieve ("3"). Specifies whether or not to delete retrieved emails on the server (optional).
For supported values of <srvParmValue> refer to <srvParmValue-pDelFlag>.
tcpMR
Parameter can be used to overwrite the global AT^SCFG parameter "Tcp/MaxRetransmissions" <tcpMr> for a specific Internet Service connection pro­file. If the parameter is not specified the value specified with AT^SCFG will be used.
Supported values <srvParmValue> for this parameter are the same as described for <tcpMr>.
Setting is not relevant for Internet Service "Socket" with type "UDP".
tcpOT
Parameter can be used to overwrite the global AT^SCFG parameter "Tcp/Over­allTimeout" <tcpOt> for a specific Internet Service connection profile. If the parameter is not specified the value specified with AT^SCFG will be used.
Supported values <srvParmValue> for this parameter are the same as described for <tcpOt>.
Setting is not relevant for Internet Service "Socket" with type "UDP".
 
Parameter value; type and supported content depend on related <srvParmTag>.
 
Supported Internet service type values in <srvParmValue> for <srvParmTag> value "srvType".
Before changing the "srvType" of an existing service profile be sure that the profile is closed. To verify the con­nection state of the service profile enter the read command AT^SISI. Only when <srvState>=2 is returned for this specific service profile you can change its service type.
“Socket“
TC65 acting as client or server (listener) for TCP or UDP.
If TC65 is TCP listener at least two service profiles are required. The first socket profile must be configured as listener. The second service profile will be dynamically assigned when a socket connection request from a remote client is incoming. For this purpose, one service profile must be left free (= not con­figured with AT^SISS). An incoming socket connection request will be indi­cated by the "^SIS" URC, with the next free <srvProfileId> shown inside the URC as parameter <urcInfoId>. The connection request can be accepted or rejected by using the commands AT^SISO or AT^SISC and the ID retrieved from the "^SIS".
“Ftp“
TC65 acting as FTP client.
“Http“
TC65 acting as HTTP client.
“Smtp“
TC65 acting as SMTP client.
“Pop3“
TC65 acting as POP3 client.
“none“
Reset Internet service profile settings. Operation is not allowed if profile is in use, i.e. it was activated via AT^SISO.
 
Supported string parameter character set selections in <srvParmValue> for <srvParmTag> value "alphabet".
[“0“]
Applicable character set is determined by current setting of AT+CSCS.
“1“
International Reference Alphabet (IRA, seven bit ASCII).
 
Supported POP3 user command values in <srvParmValue> for <srvParmTag> value "pCmd".
1
Status command.
This command retrieves the "drop listing" of a POP3 server. A "drop listing" consists of a single line containing the number of messages in the maildrop list followed by the total size of the maildrop list in bytes. Each drop listing will be finished by a so-called "dotline", i.e. a new line with just a single dot.
2
List command.
If <srvParmTag> value "pNumber" is set to a non-zero value the "List" com­mand returns the "scan listing", consisting of a single line which contains the message number and the message size in bytes if the specified message exists in the maildrop list on the POP3 server.
If no such message exists on the server than the POP3 service issues an error response to the user.
If <srvParmTag> value "pNumber" is zero the "List" command returns a multi-line "scan listing". For each message on the maildrop list of the server the POP3 service returns a line containing the message number and its size in bytes. A final "dotline" will be printed at the end of the "scan listing".
If there are no messages on the maildrop list of the server, the POP3 service returns a positive response, i.e. it doesn't issue an error response, but the "scan listing" will be empty.
In either case, each scan listing will be finished by a so-called "dotline", i.e. a new line with just a single dot.
3
Retrieve command.
If <srvParmTag> value "pNumber" is set to a non-zero value this command retrieves the related message from the POP3 server's maildrop list.
If no such message exists on the server the POP3 service issues an error response to the user.
It depends on the parameter "pDelFlag" if the message will be deleted from the POP3 server upon successful retrieval.
If <srvParmTag> value "pNumber" is zero the "Retrieve" command returns all messages pending in the POP3 server's maildrop.
If there are no messages on the maildrop list of the server the POP3 service returns with a positive response, i.e. it doesn't issue an error response, but the returned list will be empty.
Each email will be finished by a so-called "dotline", i.e. a new line with just a single dot.
4
Delete command
If <srvParmTag> value "pNumber" is set to a non-zero value the command deletes the related message from the POP3 server's maildrop list. In fact, the message is marked as deleted on the server and will be deleted permanently if the POP3 service command executes successfully. In case an error has occurred, e.g. network loss, the message will not be deleted on the server even though the POP3 service command has been finished.
If <srvParmTag> value "pNumber" is zero the "Delete" command deletes all messages from the POP3 server's maildrop list. In fact, the messages are marked as deleted on the server and will be deleted permanently if the POP3 service command executes successfully. In case an error has occurred, the messages will not be deleted on the server even though the POP3 service command has been finished.
 
Supported flag values in <srvParmValue> for <srvParmTag> value "pDelFlag". Only applicable if the profile contains the POP3 user command Retrieve ("3").
[0]
Messages will not be deleted on the server.
1
Delete messages on the server which have been retrieved successfully.


Note
•